[BETA] Get Toppie Campaigns

Retrieve a list of campaigns associated with a specific account.

Query Parameters

next_page

string

Pagination cursor as provided in an earlier response. If provided will fetch the next page of results.

limit

integer

default:

100

Limit of accounts to retrieve.

Required range: 0 < x < 100

Response

200

application/json

Successful Response

campaigns

object[]

required

List of campaigns that belong to the agency

Show child attributes

campaigns.accountId

string

required

Account that owns this campaign

campaigns.adFormat

enum<string>

required

The ads format for this campaign (only listing is currently supported)

Available options:

listing,

banner,

exclusive_listing

campaigns.budget

integer

required

Total budget for this campaign

campaigns.budgetPeriod

enum<string>

required

The periodicity of the budget

Available options:

daily,

weekly,

monthly,

total

campaigns.chargeType

enum<string>

required

The charge type for this campaign

Available options:

CPM,

CPC,

CPA

campaigns.createdAt

string

required

Date and time when the campaign was created

campaigns.currencyCode

string

required

Currency code this campaign is working with in ISO 4217 format

campaigns.id

string

required

Internal identifier for the agency campaign

campaigns.isActive

boolean

required

Flag to indicate if the campaign is active or not

campaigns.name

string

required

Campaign name

campaigns.targetRoas

number

required

Target ROAS for the campaign

Required range: 0.5 < x < 20

campaigns.bidCount

integer

Bid count for the campaign (optional)

campaigns.endDate

string

Date when to stop the campaign, specified in RFC 3339, if not set the campaign will never stop. This date must be greater than the start date and must be in the future. Must include the Timezone definition.

campaigns.startDate

string

Date when to start the campaign, specified in RFC 3339, if not set that campaign will start immediately after the campaign creation. Must include the Timezone definition.

hasMore

boolean

required

Flag that indicates whether more results are available. true indicates there is a next page of results. false indicates this response contains the last page of results.

nextPage

string

Pagination cursor. Provide this value as a next_page query parameter in a new request to retrieve the next page of results.

Minimum length: 1